package org.dromara.system.controller.system;

import cn.dev33.satoken.annotation.SaCheckPermission;
import cn.dev33.satoken.annotation.SaCheckRole;
import cn.dev33.satoken.annotation.SaMode;
import cn.hutool.core.lang.tree.Tree;
import lombok.RequiredArgsConstructor;
import org.dromara.common.core.constant.TenantConstants;
import org.dromara.common.core.constant.UserConstants;
import org.dromara.common.core.domain.R;
import org.dromara.common.core.utils.StringUtils;
import org.dromara.common.log.annotation.Log;
import org.dromara.common.log.enums.BusinessType;
import org.dromara.common.satoken.utils.LoginHelper;
import org.dromara.common.web.core.BaseController;
import org.dromara.system.domain.SysMenu;
import org.dromara.system.domain.bo.SysMenuBo;
import org.dromara.system.domain.vo.MenuTreeSelectVo;
import org.dromara.system.domain.vo.RouterVo;
import org.dromara.system.domain.vo.SysMenuVo;
import org.dromara.system.service.ISysMenuService;
import org.springframework.validation.annotation.Validated;
import org.springframework.web.bind.annotation.*;

import java.util.List;


/**
 * @Author 刘武贵
 * @Date 2024/8/15 22:00
 * @Description 功能描述：菜单信息
 */
@Validated
@RequiredArgsConstructor
@RestController
@RequestMapping("/system/menu")
public class SysMenuController extends BaseController {

    /**
     * 菜单 业务层
     */
    private final ISysMenuService menuService;

    /**
     * 获取路由信息
     * 本方法主要用于根据当前登录用户的权限，动态生成其可访问的路由信息，以便前端根据这些信息渲染相应的导航菜单和路由守卫
     * 它首先调用服务方法获取用户菜单树，然后将这些菜单转换为前端所需的路由格式
     *
     * @return 路由信息
     */
    @GetMapping("/getRouters")
    public R<List<RouterVo>> getRouters() {
        // 根据登录用户ID查询该用户的所有菜单权限，这些菜单已经按照父级菜单分组
        List<SysMenu> menus = menuService.selectMenuTreeByUserId(LoginHelper.getUserId());
        // 将查询到的菜单列表转换为前端所需的路由格式
        return R.ok(menuService.buildMenus(menus));
    }

    /**
     * 获取菜单列表
     * 该方法通过调用menuService的selectMenuList方法，根据传入的查询条件和登录用户ID，
     * 获取相应的菜单列表，并将这些列表封装到R对象中，标记操作成功
     *
     * @param menu SysMenuBo类型的参数，用于接收查询条件
     * @return 返回一个R对象，其中包含查询到的SysMenuVo类型列表
     */
    @SaCheckRole(value = {
            TenantConstants.SUPER_ADMIN_ROLE_KEY,
            TenantConstants.TENANT_ADMIN_ROLE_KEY
    }, mode = SaMode.OR)
    @SaCheckPermission("system:menu:list")
    @GetMapping("/list")
    public R<List<SysMenuVo>> list(SysMenuBo menu) {
        List<SysMenuVo> menus = menuService.selectMenuList(menu, LoginHelper.getUserId());
        return R.ok(menus);
    }

    /**
     * 根据菜单编号获取详细信息
     * 此方法的作用是通过菜单ID查询并返回相应的菜单信息这是通过调用menuService的selectMenuById方法实现的，
     * 其中menuService是一个负责处理菜单相关业务逻辑的服务类，selectMenuById方法专门用于根据ID查询菜单信息
     * 方法返回一个R类型的对象，其中包含了SysMenuVo实例，SysMenuVo是用于展示菜单信息的视图对象，
     * 它包含了前端展示所需的各种菜单字段信息返回R对象的原因是为了统一封装响应信息，便于错误处理和响应状态码的管理
     *
     * @param menuId 菜单ID
     * @return 返回封装了菜单信息的响应对象，表示操作成功并包含菜单详细信息
     */
    @SaCheckRole(value = {
            TenantConstants.SUPER_ADMIN_ROLE_KEY,
            TenantConstants.TENANT_ADMIN_ROLE_KEY
    }, mode = SaMode.OR)
    @SaCheckPermission("system:menu:query")
    @GetMapping(value = "/{menuId}")
    public R<SysMenuVo> getInfo(@PathVariable Long menuId) {
        return R.ok(menuService.selectMenuById(menuId));
    }

    /**
     * 获取菜单下拉树列表
     * 根据给定的菜单信息，查询数据库并构建树结构选项列表
     * 此方法用于响应菜单选择操作，通过调用服务层方法获取菜单列表数据，并将其转换为树结构以供前端选择使用
     *
     * 关键点解释：
     * 1. 使用SysMenuBo对象作为查询条件传递给服务层方法，以获取个性化的菜单列表
     * 2. 服务层的selectMenuList方法负责根据传递的条件和当前登录用户ID来查询数据库，返回菜单数据
     * 3. buildMenuTreeSelect方法被调用来将查询到的菜单列表转换为树结构，以便于前端展示为树形选择框
     * 4. R.ok方法用于包装返回结果，表示操作成功，其中的泛型参数指定返回的数据类型为List<Tree<Long>>
     *
     * @param menu 菜单对象，包含查询条件和当前用户信息
     * @return 返回一个Result对象，其中包含构建好的树结构列表
     */
    @SaCheckPermission("system:menu:query")
    @GetMapping("/treeselect")
    public R<List<Tree<Long>>> treeselect(SysMenuBo menu) {
        List<SysMenuVo> menus = menuService.selectMenuList(menu, LoginHelper.getUserId());
        return R.ok(menuService.buildMenuTreeSelect(menus));
    }

    /**
     * 加载对应角色菜单列表树
     * 该方法用于角色分配权限时，提供一个树状结构的菜单选择界面，并高亮已分配的菜单
     *
     * @param roleId 角色ID
     * @return 返回封装了菜单树选择数据的Result对象，包括所有菜单及已选中菜单
     */
    @SaCheckPermission("system:menu:query")
    @GetMapping(value = "/roleMenuTreeselect/{roleId}")
    public R<MenuTreeSelectVo> roleMenuTreeselect(@PathVariable("roleId") Long roleId) {
        // 查询当前登录用户的所有菜单
        List<SysMenuVo> menus = menuService.selectMenuList(LoginHelper.getUserId());
        // 初始化菜单树选择VO
        MenuTreeSelectVo selectVo = new MenuTreeSelectVo();
        // 设置已分配给角色的菜单
        selectVo.setCheckedKeys(menuService.selectMenuListByRoleId(roleId));
        // 构建菜单树选择结构
        selectVo.setMenus(menuService.buildMenuTreeSelect(menus));
        // 返回菜单树选择数据
        return R.ok(selectVo);
    }

    /**
     * 加载对应租户套餐菜单列表树
     * 该方法用于根据套餐ID查询该套餐所包含的菜单权限树，用于后台管理系统中套餐菜单配置页面的菜单树展示和选择
     *
     * @param packageId 租户套餐ID
     * @return 返回封装了菜单树选择数据的对象，包括已选择的菜单项和菜单树结构
     */
    @SaCheckRole(TenantConstants.SUPER_ADMIN_ROLE_KEY)
    @SaCheckPermission("system:menu:query")
    @GetMapping(value = "/tenantPackageMenuTreeselect/{packageId}")
    public R<MenuTreeSelectVo> tenantPackageMenuTreeselect(@PathVariable("packageId") Long packageId) {
        // 查询当前登录用户的所有菜单权限列表
        List<SysMenuVo> menus = menuService.selectMenuList(LoginHelper.getUserId());
        // 创建用于封装菜单树选择数据的VO对象
        MenuTreeSelectVo selectVo = new MenuTreeSelectVo();
        // 设置已选择的菜单项，即该套餐所包含的菜单项
        selectVo.setCheckedKeys(menuService.selectMenuListByPackageId(packageId));
        // 构建菜单树结构并设置到VO对象中
        selectVo.setMenus(menuService.buildMenuTreeSelect(menus));
        // 返回封装了菜单树选择数据的结果对象
        return R.ok(selectVo);
    }

    /**
     * 新增菜单
     * 该方法用于向系统中添加新的菜单项，在添加之前会校验菜单名是否唯一，并检查菜单路径是否以http(s)://开头
     * 如果菜单为框架菜单（isFrame为YES_FRAME），还会进一步校验路径的格式
     * </p>
     *
     * @param menu 要添加的菜单项，通过@Validated确保传入的数据符合要求
     * @return R<Void>类型，包含操作结果，失败时会返回具体原因
     */
    @SaCheckRole(TenantConstants.SUPER_ADMIN_ROLE_KEY)
    @SaCheckPermission("system:menu:add")
    @Log(title = "菜单管理", businessType = BusinessType.INSERT)
    @PostMapping
    public R<Void> add(@Validated @RequestBody SysMenuBo menu) {
        // 检查菜单名是否唯一
        if (!menuService.checkMenuNameUnique(menu)) {
            return R.fail("新增菜单'" + menu.getMenuName() + "'失败，菜单名称已存在");
            // 检查框架菜单的路径是否以http(s)://开头
        } else if (UserConstants.YES_FRAME.equals(menu.getIsFrame()) && !StringUtils.ishttp(menu.getPath())) {
            return R.fail("新增菜单'" + menu.getMenuName() + "'失败，地址必须以http(s)://开头");
        }
        return toAjax(menuService.insertMenu(menu));
    }

    /**
     * 修改菜单
     *
     * @param menu SysMenuBo对象，包含要修改的菜单信息
     * @return R<Void>类型，表示修改操作的结果
     */
    @SaCheckRole(TenantConstants.SUPER_ADMIN_ROLE_KEY)
    @SaCheckPermission("system:menu:edit")
    @Log(title = "菜单管理", businessType = BusinessType.UPDATE)
    @PutMapping
    public R<Void> edit(@Validated @RequestBody SysMenuBo menu) {
        // 检查菜单名称是否唯一，如果不唯一则返回失败提示
        if (!menuService.checkMenuNameUnique(menu)) {
            return R.fail("修改菜单'" + menu.getMenuName() + "'失败，菜单名称已存在");
            // 检查是否为框架类型菜单，且路径是否合法，如果不合法则返回失败提示
        } else if (UserConstants.YES_FRAME.equals(menu.getIsFrame()) && !StringUtils.ishttp(menu.getPath())) {
            return R.fail("修改菜单'" + menu.getMenuName() + "'失败，地址必须以http(s)://开头");
            // 检查上级菜单是否为自己，如果是则返回失败提示
        } else if (menu.getMenuId().equals(menu.getParentId())) {
            return R.fail("修改菜单'" + menu.getMenuName() + "'失败，上级菜单不能选择自己");
        }
        return toAjax(menuService.updateMenu(menu));
    }

    /**
     * 删除菜单
     *
     * @param menuId 菜单ID
     * @return 删除操作的结果，包含状态和消息
     */
    @SaCheckRole(TenantConstants.SUPER_ADMIN_ROLE_KEY)
    @SaCheckPermission("system:menu:remove")
    @Log(title = "菜单管理", businessType = BusinessType.DELETE)
    @DeleteMapping("/{menuId}")
    public R<Void> remove(@PathVariable("menuId") Long menuId) {
        // 检查当前菜单下是否存在子菜单，如果存在则不允许删除
        if (menuService.hasChildByMenuId(menuId)) {
            return R.warn("存在子菜单,不允许删除");
        }
        // 检查当前菜单是否已经被分配给角色，如果已分配则不允许删除
        if (menuService.checkMenuExistRole(menuId)) {
            return R.warn("菜单已分配,不允许删除");
        }
        return toAjax(menuService.deleteMenuById(menuId));
    }

}
